查询 Charge 对象列表

返回之前创建过 charge 对象的一个列表。列表是按创建时间进行排序,总是将最新的 charge 对象显示在最前。如果不设置 created 参数,默认查询近一个月的数据;设置了 created 参数,会按照对应的时间段查询。

请求参数描述
app[id] expandable required string支付使用的 app 对象的 id,expandable 可展开,查看如何获取App ID
limit optional,int限制有多少对象可以被返回,限制范围是从 1~100 项,默认是 10 项。
starting_after optional,string在分页时使用的指针,决定了列表的第一项从何处开始。假设你的一次请求返回列表的最后一项的 idobj_end,你可以使用 starting_after = obj_end 去获取下一页。
ending_before optional,string在分页时使用的指针,决定了列表的最末项在何处结束。假设你的一次请求返回列表的第一项的 idobj_start,你可以使用 ending_before = obj_start 去获取上一页。
created optional,timestamp对象的创建时间,用 Unix 时间戳表示。具体参考下表 created 参数。
channel optional,string支付使用的支付渠道。参考 支付渠道属性值
paid optional,boolean是否已付款。
refunded optional,boolean是否存在退款信息,无论退款是否成功。
reversed optional,boolean是否已撤销。
created 参数描述
created[gt] optional int大于 charge 对象的创建时间,用 Unix 时间戳表示。
created[gte] optional int大于或等于 charge 对象的创建时间,用 Unix 时间戳表示。
created[lt] optional int小于 charge 对象的创建时间,用 Unix 时间戳表示。
created[lte] optional int小于或等于 charge 对象的创建时间,用 Unix 时间戳表示。

返回

返回一个已存在的 charge 对象列表或者一个错误,详见 错误

定义

GET https://api.pingxx.com/v1/charges?expand[]=app
\Pingpp\Charge::all();
Charge.all(Map options);
Pingpp::Charge.all
pingpp.charges.list();
pingpp.Charge.all()
charge.List(&ChargeListParams)
list(Dictionary<String, Object> params)

请求示例

curl https://api.pingxx.com/v1/charges/?limit=3&expand[]=app \
-u sk_test_ibbTe5jLGCi5rzfH4OqPW9KC:
\Pingpp\Pingpp::setApiKey('sk_test_ibbTe5jLGCi5rzfH4OqPW9KC');
\Pingpp\Charge::all(array('limit' => 3));
Pingpp.apiKey = "sk_test_ibbTe5jLGCi5rzfH4OqPW9KC";
Map<String, Object> chargeParams = new HashMap<String, Object>();
chargeParams.put("limit", 3);
Charge.all(chargeParams);
require "pingpp"
Pingpp.api_key = "sk_test_ibbTe5jLGCi5rzfH4OqPW9KC"
Pingpp::Charge.all(:limit => 3)
var pingpp = require('pingpp')('sk_test_ibbTe5jLGCi5rzfH4OqPW9KC');
pingpp.charges.list({ limit: 3 }, function(err, charges) {
    // 异步调用
});
import pingpp
pingpp.api_key = 'sk_test_ibbTe5jLGCi5rzfH4OqPW9KC'
res = pingpp.Charge.all(limit=3)
pingpp.Key := "sk_test_ibbTe5jLGCi5rzfH4OqPW9KC"
params := &pingpp.ChargeListParams{}
params.Filters.AddFilter("limit", "", "3")
params.Single = true
i := charge.List(params)
for i.Next() {
  c := i.Charge()
}
Dictionary<String, Object> chargeParams = new Dictionary<String, Object>();
chargeParams.Add("limit", 3);
try {
    ChargeList chs = Charge.list(chargeParams);
     Console.WriteLine(chs);
} catch (AuthenticationException e) {
     Console.WriteLine(e.Message.ToString());
}

返回示例

{
  "object": "list",
  "url": "/v1/charges",
  "has_more": false,
  "data": [
    {
      "id": "ch_L8qn10mLmr1GS8e5OODmHaL4",
      "object": "charge",
      "created": 1410834527,
      "livemode": true,
      "paid": false,
      "refunded": false,
      "reversed": false,
      "app": "app_1Gqj58ynP0mHeX1q",
      "channel": "upacp",
      "order_no": "123456789",
      "client_ip": "127.0.0.1",
      "amount": 100,
      "amount_settle": 100,
      "currency": "cny",
      "subject": "Your Subject",
      "body": "Your Body",
      "extra":{},
      "time_paid": null,
      "time_expire": 1410838127,
      "time_settle": null,
      "transaction_no": null,
      "refunds": {
        "object": "list",
        "url": "/v1/charges/ch_L8qn10mLmr1GS8e5OODmHaL4/refunds",
        "has_more": false,
        "data": [ ]
      },
      "amount_refunded": 0,
      "failure_code": null,
      "failure_msg": null,
      "metadata": {},
      "credential": {
        "object": "credential",
        "upacp": {
          "tn": "201409161028470000000",
          "mode": "01"
        }
      },
      "description": null
    }
  ]
}